you might also need to enable github CI/CD on PRs - somehwere in github settings.

some documentation might be useful - please indicate where you want the info on how to run autopep8 etc., then I can add that (or you can quickly if you feel like it) :)

Thank you for this pull request @osingaatje. I think I'll need to read a bit more about GitHub workflows to fully understand how to set this up.

I agree with the arbitrary choice of max line length, that's why I kept the formatting check on the default settings.

Same with the multi-line comments. PEP8 is what Python officially states as the standard so I'm not going to quibble about the exact formatting of lines, as long as they're done the same way every time.

By the way, an example of when CI/CD is turned on:

Same with the multi-line comments. PEP8 is what Python officially states as the standard so I'm not going to quibble about the exact formatting of lines, as long as they're done the same way every time.

Yes, I agree. Being predictable is better than being perfect. I pointed out that one commenting rule, because after reformatting the code does not comply with the guidelines. Part of the comments are at the wrong side of the code.

It looks like I cannot configure, enable or trigger the workflow until it is (also) on main. I was able to find the runs on your fork, so if we can get it to a point where everything passes using the final configuration, then we should be good to go.

I updated the formatting on the PR branch, but cannot push it. If you want it, you probably need to check 'allow editing by maintainer'.

And regarding your documentation question. I think it is time to start a contributing readme.

Same with the multi-line comments. PEP8 is what Python officially states as the standard so I'm not going to quibble about the exact formatting of lines, as long as they're done the same way every time.

Yes, I agree. Being predictable is better than being perfect. I pointed out that one commenting rule, because after reformatting the code does not comply with the guidelines. Part of the comments are at the wrong side of the code.

sounds like a bug report to autopep8 :)

I updated the formatting on the PR branch, but cannot push it. If you want it, you probably need to check 'allow editing by maintainer'.

I don't see it currently unfortunately :(

And regarding your documentation question. I think it is time to start a contributing readme.

probably a good idea :)

I rebased with your current main and formatted the code in 57e8d29

I updated the formatting on the PR branch, but cannot push it. If you want it, you probably need to check 'allow editing by maintainer'.

did formatting myself in 57e8d29

Remaining tasks for this PR:

• add workflow file for run_demo miss and run_demo extended
• Create first basic contributing guideline document
• Check that all workflows pass
• Merge and enable workflow on main

@osingaatje, can you help to check the latest commits?

Reminder: exit code propagation is not in place yet for the demo runs.

@JFoederer robotnl is not in the dependencies (demo/Titanic/MapLib.py)

otherwise all tests pass

@JFoederer robotnl is not in the dependencies (demo/Titanic/MapLib.py)

Thanks for checking. The demo has its own requirements.txt, so I guess I picked the wrong installation method.

By the way, the demo also has some optional dependencies. The manual now asks to install them separately if you want to use the graphical enhancements.

I would like to improve this by using the optional dependencies structure you showed before. We will not include that in this PR though. Maybe it can be combined with the extra options needed for the graphs later on.

so I guess I picked the wrong installation method.

Or wrong working directory for the 'Install dependencies' step?

I would like to improve this by using the optional dependencies structure you showed before. We will not include that in this PR though. Maybe it can be combined with the extra options needed for the graphs later on.

That is definitely possible. I will put a TODO in our team's Trello for this, once we have the final PRs ready.

contributing

see my improvements at b680d92

@osingaatje, which style guide did you use for .md? I am getting a few new warnings. For instance on missing white lines around headings.

And thank you for the improvements. Most were ok, but you also found one that was open for interpretation. I think I clarified that now.

I did not use any style guide... just what I found nice to read (I don't often render the markdown)

Ok, clear. No problem, I will fix the .md linting issues and wrap it up.

Unfortunately the final check, on main, failed: PR #41

A fix is now included in PR #41. All done.

Very nice! Thank you for the cooperation, nice to see it in action in pr #41 :)

Yes, I agree. On both accounts. That was good work together!